rustdoc: Test & document test_harness code block attribute
#148183
+193
−17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
S-waiting-on-review
|
rustbot has assigned @GuillaumeGomez. Use |
fmease
commented
Oct 27, 2025
| None, | ||
| Some(Vec<String>), | ||
| } | ||
|
|
There was a problem hiding this comment.
It's not any old ENBF1 (variant), it's ABNF2 specifically (from IETF RFC 5234) which I previously didn't know about (and thus was confused about the syntax).
Footnotes
| /// delimited-attribute-list = OPEN-CURLY-BRACKET attribute-list CLOSE-CURLY-BRACKET | ||
| /// token-list = [sep] token *(sep token) [sep] | ||
| /// comment = OPEN_PAREN *(all characters) CLOSE_PAREN | ||
| /// comment = OPEN_PAREN *<all characters except closing parentheses> CLOSE_PAREN |
There was a problem hiding this comment.
Prose terminals are to be denoted by <…> not by (…) (which is grouping) per IETF RFC 5234 (Ctrl+F for prose-val).
fmease
force-pushed
the
rustdoc-test-n-doc-doctest-test-harness
branch
from
eab1d61 to
5e7f083
Compare
This comment has been minimized.
This comment has been minimized.
fmease
force-pushed
the
rustdoc-test-n-doc-doctest-test-harness
branch
from
5e7f083 to
c687f89
Compare
This comment has been minimized.
This comment has been minimized.
fmease
force-pushed
the
rustdoc-test-n-doc-doctest-test-harness
branch
from
c687f89 to
f71d897
Compare
This comment has been minimized.
This comment has been minimized.
fmease
force-pushed
the
rustdoc-test-n-doc-doctest-test-harness
branch
from
f71d897 to
9a78729
Compare
This comment has been minimized.
This comment has been minimized.
fmease
force-pushed
the
rustdoc-test-n-doc-doctest-test-harness
branch
from
9a78729 to
3a17eba
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
They were fully untested and undocumented previously despite being stable.
Context: #t-rustdoc > `test_harness` langstr @ 💬.
While at it, I've also improved the documentation for code block attributes in general.
I was only inspired to do so because there was no good place for
test_harnessand because it got hard to skim due to a lack of subsubsections.